<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkStreamableContent</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="atk-AtkStateSet.html" title="AtkStateSet">
<link rel="next" href="AtkTable.html" title="AtkTable">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="atk-AtkStateSet.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkTable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#AtkStreamableContent.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#AtkStreamableContent.description" class="shortcut">Description</a>
                   | 
                  <a href="#AtkStreamableContent.object-hierarchy" class="shortcut">Object Hierarchy</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="AtkStreamableContent"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtkStreamableContent.top_of_page"></a>AtkStreamableContent</span></h2>
<p>AtkStreamableContent — The ATK interface which provides access to streamable content.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AtkStreamableContent.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a class="link" href="AtkStreamableContent.html#AtkStreamableContent-struct" title="AtkStreamableContent">AtkStreamableContent</a>;
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                <a class="link" href="AtkStreamableContent.html#atk-streamable-content-get-n-mime-types" title="atk_streamable_content_get_n_mime_types ()">atk_streamable_content_get_n_mime_types</a>
                                                        (<a class="link" href="AtkStreamableContent.html" title="AtkStreamableContent">AtkStreamableContent</a> *streamable);
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>*        <a class="link" href="AtkStreamableContent.html#atk-streamable-content-get-mime-type" title="atk_streamable_content_get_mime_type ()">atk_streamable_content_get_mime_type</a>
                                                        (<a class="link" href="AtkStreamableContent.html" title="AtkStreamableContent">AtkStreamableContent</a> *streamable,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> i);
<a
href="/usr/share/gtk-doc/html/glib/glib-IO-Channels.html#GIOChannel"
>GIOChannel</a>*         <a class="link" href="AtkStreamableContent.html#atk-streamable-content-get-stream" title="atk_streamable_content_get_stream ()">atk_streamable_content_get_stream</a>   (<a class="link" href="AtkStreamableContent.html" title="AtkStreamableContent">AtkStreamableContent</a> *streamable,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *mime_type);
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>*              <a class="link" href="AtkStreamableContent.html#atk-streamable-content-get-uri" title="atk_streamable_content_get_uri ()">atk_streamable_content_get_uri</a>      (<a class="link" href="AtkStreamableContent.html" title="AtkStreamableContent">AtkStreamableContent</a> *streamable,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *mime_type);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="AtkStreamableContent.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----AtkStreamableContent
</pre>
</div>
<div class="refsect1" lang="en">
<a name="AtkStreamableContent.description"></a><h2>Description</h2>
<p>
An interface whereby an object allows its backing content to be streamed to
clients.  Typical implementors would be images or icons, HTML content, or
multimedia display/rendering widgets.
</p>
<p>
Negotiation of content type is allowed. Clients may examine the backing data
and transform, convert, or parse the content in order to present it in an alternate form to end-users.
</p>
<p>
The AtkStreamableContent interface is particularly useful for saving,
printing, or post-processing entire documents, or for persisting alternate
views of a document. If document content itself is being serialized,
stored, or converted, then use of the AtkStreamableContent interface can help
address performance issues. Unlike most ATK interfaces,
this interface is not strongly tied to the current user-agent view of the
a particular document, but may in some cases give access to the underlying model data.
</p>
</div>
<div class="refsect1" lang="en">
<a name="AtkStreamableContent.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="AtkStreamableContent-struct"></a><h3>AtkStreamableContent</h3>
<pre class="programlisting">typedef struct _AtkStreamableContent AtkStreamableContent;</pre>
<p>
The AtkStreamableContent structure does not contain any fields.

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-streamable-content-get-n-mime-types"></a><h3>atk_streamable_content_get_n_mime_types ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a>                atk_streamable_content_get_n_mime_types
                                                        (<a class="link" href="AtkStreamableContent.html" title="AtkStreamableContent">AtkStreamableContent</a> *streamable);</pre>
<p>
Gets the number of mime types supported by this object.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>streamable</code></em> :</span></p></td>
<td> a GObject instance that implements AtkStreamableContentIface
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a gint which is the number of mime types supported by the object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-streamable-content-get-mime-type"></a><h3>atk_streamable_content_get_mime_type ()</h3>
<pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>*        atk_streamable_content_get_mime_type
                                                        (<a class="link" href="AtkStreamableContent.html" title="AtkStreamableContent">AtkStreamableContent</a> *streamable,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> i);</pre>
<p>
Gets the character string of the specified mime type. The first mime
type is at position 0, the second at position 1, and so on.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>streamable</code></em> :</span></p></td>
<td> a GObject instance that implements AtkStreamableContent
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>i</code></em> :</span></p></td>
<td> a gint representing the position of the mime type starting from 0
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>: a gchar* representing the specified mime type; the caller
should not free the character string.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-streamable-content-get-stream"></a><h3>atk_streamable_content_get_stream ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-IO-Channels.html#GIOChannel"
>GIOChannel</a>*         atk_streamable_content_get_stream   (<a class="link" href="AtkStreamableContent.html" title="AtkStreamableContent">AtkStreamableContent</a> *streamable,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *mime_type);</pre>
<p>
Gets the content in the specified mime type.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>streamable</code></em> :</span></p></td>
<td> a GObject instance that implements AtkStreamableContentIface
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
<td> a gchar* representing the mime type
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A <a
href="/usr/share/gtk-doc/html/glib/glib-IO-Channels.html#GIOChannel"
><span class="type">GIOChannel</span></a> which contains the content in the specified mime
type.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-streamable-content-get-uri"></a><h3>atk_streamable_content_get_uri ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>*              atk_streamable_content_get_uri      (<a class="link" href="AtkStreamableContent.html" title="AtkStreamableContent">AtkStreamableContent</a> *streamable,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *mime_type);</pre>
<p>
Get a string representing a URI in IETF standard format
(see http://www.ietf.org/rfc/rfc2396.txt) from which the object's content
may be streamed in the specified mime-type, if one is available.
If mime_type is NULL, the URI for the default (and possibly only) mime-type is
returned. 
</p>
<p>
Note that it is possible for get_uri to return NULL but for
get_stream to work nonetheless, since not all GIOChannels connect to URIs.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>streamable</code></em> :</span></p></td>
<td> a GObject instance that implements AtkStreamableContentIface
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mime_type</code></em> :</span></p></td>
<td> a gchar* representing the mime type, or NULL to request a URI 
for the default mime type.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>  Returns a string representing a URI, or NULL if no corresponding URI
can be constructed.

</td>
</tr>
</tbody>
</table></div>
<p class="since">Since  ATK 1.12
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>
